![]() |
CuDoubleSidedScannerAPI
1.11
|
Collects all log settings, such as verbosity, log path, log folder maximum dimension... More...
Public Types | |
| enum | LogVerbosityLevel : byte |
| Verbosity level. More... | |
Public Member Functions | |
| LogSetting () | |
| Constructor. Set default values: LogVerbosity = Custom.CuDoubleSidedScannerAPIWrap.LogSetting.LogVerbosityLevel .DBGLVL_ERROR LogFilePath = "" LogScannedImages = false LogCommunicationData = false BackupLogFiles = false KeepAllLogImages = false MaxLogFileSize = 20 MB MaxImageFileNum = 20 More... | |
Public Attributes | |
| LogVerbosityLevel | LogVerbosity |
| Indicates the log verbosity level More... | |
| String | LogFilePath |
| Log file path. If empty or null (not specified by the user), log files are created in the folder "%Documents%\CUSTOM\CuDoubleSidedScannerAPI", and log images in "%Documents%\CUSTOM\CuDoubleSidedScannerAPI\Images". More... | |
| Boolean | LogScannedImages |
| Select whether to log also scanned images or not. If true, also log scanned images. Images are stored into the log folder, "Images" subfolder. False by default. More... | |
| Boolean | LogCommunicationData |
| Select whether to log also communication data. If true, also log communication data. It could create an huge amount of logged data . False by default. More... | |
| Boolean | BackupLogFiles |
| If true, when the log file exceeds the maximum size, the log file is renamed (the name will contain date and time). More... | |
| Boolean | KeepAllLogImages |
| UInt32 | MaxLogFileSize |
| Maximum log file size, in MB. Default value is 20 MB. Log file size is checked only the first time a log is written, in a scanner connection section. If a log file exceeds the maximum size, and BackupLogFiles is false, the log file is deleted. If a log file exceeds the maximum size, and BackupLogFiles is true, the log file is renamed (the name will contain date and time), and log files will never be deleted (this may cause an huge amount of used space on disk). More... | |
| UInt32 | MaxImageFileNum |
| Maximum number of images into log folder. The number of image files is checked during at every API library initialization: if the number of files in the "Images" folder exceeds the maximum number, all the files contained into the folder are deleted. To never delete the image log files, set to true KeepAllLogImages. Default value is 20. More... | |
Collects all log settings, such as verbosity, log path, log folder maximum dimension...
|
strong |
Verbosity level.
|
inline |
Constructor. Set default values:
LogVerbosity = Custom.CuDoubleSidedScannerAPIWrap.LogSetting.LogVerbosityLevel .DBGLVL_ERROR
LogFilePath = ""
LogScannedImages = false
LogCommunicationData = false
BackupLogFiles = false
KeepAllLogImages = false
MaxLogFileSize = 20 MB
MaxImageFileNum = 20
| Boolean Custom.CuDoubleSidedScannerAPIWrap.LogSetting.BackupLogFiles |
If true, when the log file exceeds the maximum size, the log file is renamed (the name will contain date and time).
Referenced by Custom.CuDoubleSidedScannerAPIWrap.LogSetting.LogSetting().
| Boolean Custom.CuDoubleSidedScannerAPIWrap.LogSetting.KeepAllLogImages |
If true, the library doesn't delete the log images, also if their number exceeds the maximum allowed number.
False by default (advised).
Referenced by Custom.CuDoubleSidedScannerAPIWrap.LogSetting.LogSetting().
| Boolean Custom.CuDoubleSidedScannerAPIWrap.LogSetting.LogCommunicationData |
Select whether to log also communication data. If true, also log communication data. It could create an huge amount of logged data . False by default.
Referenced by Custom.CuDoubleSidedScannerAPIWrap.LogSetting.LogSetting().
| String Custom.CuDoubleSidedScannerAPIWrap.LogSetting.LogFilePath |
Log file path. If empty or null (not specified by the user), log files are created in the folder "%Documents%\CUSTOM\CuDoubleSidedScannerAPI", and log images in "%Documents%\CUSTOM\CuDoubleSidedScannerAPI\Images".
Referenced by Custom.CuDoubleSidedScannerAPIWrap.LogSetting.LogSetting().
| Boolean Custom.CuDoubleSidedScannerAPIWrap.LogSetting.LogScannedImages |
Select whether to log also scanned images or not. If true, also log scanned images. Images are stored into the log folder, "Images" subfolder. False by default.
Referenced by Custom.CuDoubleSidedScannerAPIWrap.LogSetting.LogSetting().
| LogVerbosityLevel Custom.CuDoubleSidedScannerAPIWrap.LogSetting.LogVerbosity |
Indicates the log verbosity level
Referenced by Custom.CuDoubleSidedScannerAPIWrap.LogSetting.LogSetting().
| UInt32 Custom.CuDoubleSidedScannerAPIWrap.LogSetting.MaxImageFileNum |
Maximum number of images into log folder.
The number of image files is checked during at every API library initialization: if the number of files in the "Images" folder exceeds the maximum number, all the files contained into the folder are deleted.
To never delete the image log files, set to true KeepAllLogImages.
Default value is 20.
Referenced by Custom.CuDoubleSidedScannerAPIWrap.LogSetting.LogSetting().
| UInt32 Custom.CuDoubleSidedScannerAPIWrap.LogSetting.MaxLogFileSize |
Maximum log file size, in MB. Default value is 20 MB. Log file size is checked only the first time a log is written, in a scanner connection section.
If a log file exceeds the maximum size, and BackupLogFiles is false, the log file is deleted.
If a log file exceeds the maximum size, and BackupLogFiles is true, the log file is renamed (the name will contain date and time), and log files will never be deleted (this may cause an huge amount of used space on disk).
Referenced by Custom.CuDoubleSidedScannerAPIWrap.LogSetting.LogSetting().